IMotion.AddAxisToGroup method

Adds an axis to a group. This command can't be buffered.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError AddAxisToGroup(
       int Index,
       int AxisIndex,
       int IndexInGroup
)

Function AddAxisToGroup(
       Index As Integer,
       AxisIndex As Integer,
       IndexInGroup As Integer
) As KsError

Parameters

Index [in]

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

AxisIndex [in]

Type: int

The axis to be added to the group. Each group can contain up to 64 axes.

IndexInGroup [in]

Type: int

The index of an axis in the group.

Return value

A return code of a method.

Remarks

It can be used only in the GroupDisabled state.
Each IndexInGroup can be used only once, otherwise it leads to an error.
If modulo axis is enabled for an axis, it cannot be added to a group. AddAxisToGroup will return errWrongEnvironment in this case.

Examples

N/A